﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////


#pragma once

#include "GcmpModelInterface.h"
#include "IExternalData.h"
#include "DbDataSchema.h"
#include "ElementId.h"
#include "GcmpApiDeclaration.h"
#include "IGraphicsStyleData.h"

namespace gcmp
{
    /// \brief 填充区域类型，用于决定填充区域的填充样式
    class GCMP_MODEL_INTERFACE_EXPORT IFilledRegionType : public IExternalData
    {
        DECLARE_CLASS_WITHOUT_DATA_MEMBERS(gcmp, IFilledRegionType, gcmp::IExternalData, b6bab797 - 39a6 - 4aa9 - b0ae - 125c3d752e82, gcmpmodelinterface)
    public:
        /// \brief 析构函数
        virtual ~IFilledRegionType() {}

    public:
        /// \brief 创建填充区域类型
        ///
        /// \param[in] pDocument 文档指针
        /// \param[in] filledPatternName 填充模式的名字
        /// \return 如果成功，则返回填充区域类型的指针，如果失败，则为nullptr
        static IFilledRegionType* Create(IDocument* pDocument, const std::wstring& filledPatternName);

        /// \brief 获取填充区域类型
        ///
        /// \param[in] 填充区域类型所在Element的指针
        /// \return 查找到的填充区域类型指针，查找失败则为空指针
        static const IFilledRegionType* GetFilledRegionType(const IElement *pElement);

        /// \brief 获取填充区域类型
        ///
        /// \param[in] 填充区域类型所在Element的指针
        /// \return 查找到的填充区域类型指针，查找失败则为空指针
        static IFilledRegionType* GetFilledRegionType(IElement *pElement);

    public:
        /// \brief 获取填充图案的颜色和透明度,透明度通过rgba中的a来表示
        ///
        /// ----------------
        /// | / / / / / / /|
        /// |/ / / / / / / |
        /// ----------------
        /// 填充区域在绘制的时候会根据填充模式的描述,生成一些图案,比如上图中的斜线,并将这些图案按照一定规则重复排列塞满区域,这个颜色就是指这些图案的颜色
        /// \return 填充图案的颜色
        virtual Color GetColor() const = 0;

        /// \brief 设置填充图案的颜色和透明度,透明度通过rgba中的a来表示
        ///
        /// ----------------
        /// | / / / / / / /|
        /// |/ / / / / / / |
        /// ----------------
        /// 填充区域在绘制的时候会根据填充模式的描述,生成一些图案,比如上图中的斜线,并将这些图案按照一定规则重复排列塞满区域,这个颜色就是指这些图案的颜色
        /// \param[in] color 填充图案的颜色
        virtual void SetColor(const Color &color) = 0;

        /// \brief 获得填充图案的智能颜色模式
        ///
        /// \return 获得的填充图案的智能颜色模式
        virtual SmartColorMode GetSmartColorMode() const = 0;

        /// \brief 设置填充图案的智能颜色模式
        /// 
        /// \param smartColorMode 设置的填充图案的智能颜色模式
        /// return 成功与否
        virtual bool SetSmartColorMode(const SmartColorMode& smartColorMode) = 0;

        /// \brief 获取填充模式名字
        ///
        /// \return 填充模式名字
        virtual std::wstring GetFillPatternName() const = 0;

        /// \brief 设置新的填充模式
        ///
        /// \param newPatternName 新填充模式名字
        /// \return 成功返回true，失败返回false；当新填充模式名字和当前填充模式名字相同，或者无法通过新填充模式名字找到填充模式时，设置失败
        virtual bool SetFillPattern(const std::wstring& newPatternName) = 0;

        /// \brief 获取填充图案的线宽
        ///
        /// \return 填充图案的线宽
        virtual double GetLineWidth() const = 0;

        /// \brief 设置填充图案的线宽
        ///
        ///  填充图案线宽模式默认使用像素模式，所以lineWidth需要大于1，但是因为希望以后支持世界单位模式，所以类型设计为double
        /// \param lineWidth 填充图案的线宽
        /// \return 成功返回true，失败返回false
        virtual bool SetLineWidth(double lineWidth) = 0;


        /// \brief 设置填充区域是否遮罩
        ///
        /// \param isMask 是否遮罩
        /// \return 成功返回true，失败返回false
        virtual bool SetIsMask(bool isMask) = 0;

        /// \brief 填充区域是否遮罩
        ///
        /// \return 返回true表示遮罩，否则不遮罩
        virtual bool IsMask() const = 0;

        /// \brief 填充图案的颜色是否是smart color
        ///
        /// \return 如果是smart color, 则返回true
        GCMP_OBSOLETE_API(21/07/01, IFilledRegionType::GetSmartColorMode()) virtual bool IsColorSmart() const = 0;

        /// \brief 设置填充图案的颜色是否是smart color, 所谓smart color, 指的是能跟随背景改变而改变
        /// 
        /// \param isSmart 填充图案的颜色是否是smart color
        GCMP_OBSOLETE_API(21/07/01, IFilledRegionType::SetSmartColorMode(const SmartColorMode&)) virtual void SetColorSmart(bool isSmart) = 0;
    };
}